Packages
List, Insert, Update, delete packages
Table Specific Information
Select
The add-in will use 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 add-in.
- Id supports the '=' comparison.
- SalesorderId supports the '=' comparison.
- CustomerName supports the '=,LIKE' comparison.
- CustomerId supports the '=' comparison.
- PackageNumber supports the '=,LIKE' comparison.
- SalesorderNumber supports the '=,LIKE' comparison.
- StatusFilter supports the '=' comparison.
- StartDate supports the '=' comparison.
- ShipmentStartDate supports the '=' comparison.
- EndDate supports the '=' comparison.
- ShipmentEndDate supports the '=' comparison.
For example, the following queries are processed server side:
SELECT * FROM Packages WHERE Id = '3350895000000089001' SELECT * FROM Packages WHERE SalesorderId = '7538224323'
Insert
Insert can be executed by specifying the CustomerName, SalesorderId, PackageNumber and Date column. The columns that are not read-only can be inserted optionally. Following is an example of how to insert into this table.
INSERT INTO Packages (CustomerName, Date, LineItems) VALUES ('test22''2022-07-01', [{\"quantity\":87}])
Update
Update can be executed by specifying the Id in the WHERE Clause. The columns that are not read-only can be Updated.
For example:
UPDATE Packages SET CustomerName = 'new' WHERE Id = 3249056000000197079
Delete
Delete can be executed by specifying the Id in the WHERE Clause
For example:
DELETE FROM Packages WHERE Id = '3350895000000089001'
Columns
| Name | Type | ReadOnly | References | Description |
| CreatedTime | Datetime | True |
Time at which the package was created. | |
| CustomerId | Long | True |
Unique ID generated by the for the customer. | |
| CustomerName | String | True |
Name of the customer. | |
| Date | Date | False |
Date on which package is prepared. | |
| String | True |
Email of contact person. | ||
| IsEmailed | Boolean | True |
Package is emailed to the customer or not. | |
| LastModifiedTime | Datetime | True |
Time at which the package details were last modified. | |
| Mobile | String | True |
Mobile number of the customer. | |
| Notes | String | False |
Notes for package. | |
| Id [KEY] | Long | True |
Id of package. | |
| PackageNumber | String | False |
Name of the package | |
| Phone | String | True |
Phone number of the customer. | |
| SalesorderId | Long | False |
Unique ID generated by the server for sales order. | |
| SalesorderNumber | String | True |
Name of the sales order for which package is created. | |
| TemplateId | Long | True |
Unique ID generated by the server for the template used for package. | |
| TemplateName | String | True |
Name of the template. | |
| TemplateType | String | True |
Type of template. | |
| TotalQuantity | Integer | True |
Total quantity in the package. | |
| LineItems | String | False |
Details of the items in this package | |
| BillingAddress | String | True |
Billing address. | |
| Carrier | String | True |
Carrier name. | |
| ContactPersons | String | True |
Contact persons. | |
| CustomFieldHash | String | True |
Hash of custom fields. | |
| DeliveryDays | Integer | True |
Number of delivery days. | |
| DeliveryMethod | String | True |
Delivery method. | |
| ExpectedDeliveryDate | Date | True |
Expected delivery date. | |
| Picklists | String | True |
Picklists. | |
| SalesChannel | String | True |
Sales channel. | |
| ShipmentOrder | String | True |
Shipment order. | |
| ShippingAddress | String | True |
Shipping address. | |
| Status | String | True |
Status. | |
| TrackingLink | String | True |
Tracking link. | |
| TrackingNumber | String | True |
Tracking number. | |
| Weight | String | True |
Weight. | |
| CreatedById | Long | True |
ID of the user who created the package. | |
| CustomFields | String | False |
Custom fields. | |
| DeliveryGuarantee | Boolean | True |
Whether delivery is guaranteed. | |
| DeliveryMethodId | Long | True |
ID of the delivery method. | |
| DetailedStatus | String | True |
Detailed status. | |
| Dimensions | String | True |
Dimensions. | |
| HandlingInstructions | String | True |
Handling instructions. | |
| IncludesPicklistTrackingInfo | Boolean | True |
Whether picklist tracking info is included. | |
| LastModifiedById | Long | True |
ID of the user who last modified the package. | |
| PackageConfigurationId | Long | True |
ID of the package configuration. | |
| PackageConfigurationName | String | True |
Name of the package configuration. | |
| SalesChannelFormatted | String | True |
Formatted sales channel. | |
| SalesorderDate | Date | True |
Date of the sales order. | |
| SalesorderFulfilmentStatus | String | True |
Fulfilment status of the sales order. | |
| Service | String | True |
Service type. | |
| ShipmentDeliveredDate | Datetime | True |
Date when shipment was delivered. | |
| ShipmentId | Long | True |
ID of the shipment. | |
| ShipmentNumber | String | True |
Shipment number. | |
| ShipmentorderCustomFields | String | True |
Custom fields of the shipment order. | |
| ShippingDate | Date | True |
Shipping date. | |
| StatusMessage | String | True |
Status message. | |
| Terms | String | True |
Terms. |
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 |
| StatusFilter | String |
Filter the packages by status. The allowed values are Status.All, Status.NotShipped, Status.Shipped, Status.Delivered. |
| StartDate | Date |
Used for searching packages from specified date |
| ShipmentStartDate | Date |
Used for searching packages from specified date of Shipment |
| EndDate | Date |
Used for searching packages till specified date |
| ShipmentEndDate | Date |
Used for searching packages till specified date of Shipment |
| SearchText | String |
Search packages by search text. |