ShipmentOrders
List, Insert, Update, Delete shipment orders
Table-Specific Information
Select
The provider uses the Zoho Inventory API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the provider.
- Id supports the '=' comparison.
For example, the following queries are processed server-side:
SELECT * FROM ShipmentOrders WHERE Id = '3350895000000089001'
Insert
To insert into this table, specify the ShipmentNumber, Date, DeliveryMethod, TrackingNumber, and PackageIds columns. Non-read-only columns can be inserted optionally. For example:
INSERT INTO ShipmentOrders (ShipmentNumber, Date, DeliveryMethod, TrackingNumber, PackageIds) VALUES ('SH-TEST-001', '2026-06-02', 'FedEx', 'TRK-TEST-001', '3782369000000067044');
Delete
To delete from this table, specify the Id in the WHERE clause. For example:
DELETE FROM ShipmentOrders WHERE Id = '3350895000000089001'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
Unique ID generated by the server for the shipment. | |
| Carrier | String | True |
Carrier used for shipment | |
| ContactPersons | Long | False |
contact persons. | |
| CreatedTime | Datetime | True |
Time at which the Shipment Details was created. | |
| CurrencyCode | String | True |
Currency code. | |
| CurrencyId | Long | True |
Unique ID generated by the server for the currency. | |
| CurrencySymbol | String | True |
The symbol for the selected currency. | |
| CustomerId | Long | True |
Unique ID generated by the for the customer. | |
| CustomerName | String | True |
Name of the customer | |
| Date | String | False |
Date on which package is prepared. | |
| DeliveryDays | Integer | True |
Number of days taken by the courier for delivering in package. | |
| DeliveryGuarantee | Boolean | True |
guarantee assured by the courier. | |
| DeliveryMethod | String | False |
Delivery method of the shipment. | |
| DeliveryMethodId | Long | True |
Delivery Id of the shipment. | |
| DetailedStatus | String | False |
Detailed shipment details received from the courier. | |
| Discount | String | True |
The percentage of Discount applied. | |
| DiscountAmount | Integer | True |
Discount to be applied on the Sales Order. | |
| DiscountType | String | True |
Type of discount. | |
| EstimateId | Long | True |
Estimate Id. | |
| ExchangeRate | Integer | False |
Exchange rate of the currency, with respect to the base currency. | |
| IsDiscountBeforeTax | Boolean | True |
Used to check whether the discount is applied before tax or after tax. | |
| IsEmailed | Boolean | True |
Checks whether the Package has been emailed to the customer or not. | |
| LastModifiedTime | Datetime | True |
Time at which the Shipment Details details were last modified. | |
| LineItems | String | True |
List of items in a package. | |
| Notes | String | False |
notes. | |
| PricePrecision | Integer | True |
The precision level for the price decimal point in a Shipment. | |
| ReferenceNumber | String | False |
Tracking number for the Shipment. | |
| SalesorderId | Long | True |
Unique ID generated by the server for the Sales Order. | |
| SalesorderNumber | String | True |
The Sales Order number. | |
| Service | String | True |
Type of service selected for shipment. | |
| ShipmentNumber | String | False |
Shipment number of the package. | |
| ShippingCharge | Integer | False |
Shipping charges that are applied to the Shipment. | |
| Status | String | True |
Status of the Shipment Order. | |
| StatusMessage | String | True |
Status message of the shipment. | |
| SubTotal | Integer | True |
Sub total of the Sales Order. | |
| TaxTotal | Integer | True |
Tax total of the Sales Order. | |
| Taxes | String | True |
Number of taxes applied on sales order.. | |
| TemplateId | Long | False |
Unique ID generated by the server for the Template. | |
| TemplateName | String | True |
Name of the template used for the Shipment. | |
| TemplateType | String | True |
Type of the template. | |
| Total | Integer | True |
Total amount of the Sales Order. | |
| TrackingNumber | String | False |
Tracking number of shipment. | |
| BillingAddressAddress | String | True |
Name of the street of the customer billing address. | |
| BillingAddressCity | String | True |
Name of the city of the customer billing address. | |
| BillingAddressCountry | String | True |
Name of the country of the customer billing address. | |
| BillingAddressFax | String | True |
Fax number of the customer billing address. | |
| BillingAddressState | String | True |
Name of the state of the customer billing address. | |
| BillingAddressZip | Integer | True |
Zip code of the customer billing address. | |
| ShippingAddressAddress | String | True |
Name of the street of the customer billing address. | |
| ShippingAddressCity | String | True |
Name of the city of the customer billing address | |
| ShippingAddressState | String | True |
Name of the state of the customer billing address. | |
| ShippingAddressZip | String | True |
Zip code of the customer billing address. | |
| ShippingAddressCountry | String | True |
Name of the country of the customer billing address. | |
| ShippingAddressFax | String | True |
Fax number of the customer billing address. | |
| AssociatedPackagesCount | Integer | True |
Count of associated packages. | |
| IsCustomShipping | Boolean | True |
Whether custom shipping is used. | |
| IsLabelAvailable | Boolean | True |
Whether a label is available. | |
| Packages | String | True |
Associated packages. | |
| SalesChannelSource | String | True |
Sales channel source. | |
| ShippingAddressCompanyName | String | True |
Company name in shipping address. | |
| TrackingKey | String | True |
Tracking key. | |
| TrackingStatuses | String | True |
Tracking statuses. | |
| IsVoidUrlAvailable | Boolean | True |
Whether void URL is available. | |
| SalesChannelSourceFormatted | String | True |
Formatted sales channel source. | |
| ShipperAccountNumber | String | True |
Shipper account number. |
Pseudocolumns
Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description |
| PackageIds | String |
Comma-separated package_id(s) to be shipped. |