Stored Procedures
Stored procedures are function-like interfaces that extend the functionality of the driver beyond simple SELECT operations with ShipStation.
Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from ShipStation, along with an indication of whether the procedure succeeded or failed.
CData JDBC Driver for ShipStation Stored Procedures
| Name | Description |
| AddTagToShipment | Adds a tag to a shipment. |
| AssignUserToShipments | Assigns a user to one or more shipments. |
| CancelShipment | Cancels a shipment. |
| CreateCombinedLabelDocument | Combines multiple label documents into a single PDF. |
| DownloadDocument | Downloads a document by its document Id. |
| DownloadFile | Downloads a generated file (label, manifest, or form) by its path. |
| DownloadPurchaseOrderSummary | Downloads the order summary PDF for a purchase order. |
| DownloadReceivedPurchaseOrderSummary | Downloads the received summary PDF for a purchase order. |
| EstimateRates | Calculates estimated shipping rates without full shipment details. |
| ReceivePurchaseOrderProducts | Records receipt of products for a purchase order. |
| RegisterLabelDocument | Registers a document against a label and returns pre-signed S3 upload credentials. |
| RegisterShipmentDocument | Registers a document against a shipment and returns pre-signed S3 upload credentials. |
| RemoveTagFromShipment | Removes a tag from a shipment. |
| SendLabelDocuments | Transmit all uploaded documents for a label to the carrier. |
| StartTracking | Starts receiving tracking updates for a shipment. |
| StopTracking | Stops receiving tracking updates for a shipment. |
| UpdatePurchaseOrderShippingDetails | Updates the shipping details for a purchase order. |
| UpdatePurchaseOrderStatus | Updates the status of a purchase order. |
| UpdateShipmentInternalNotes | Updates the internal notes for a shipment. |