Excel Add-In for ShipStation

Build 26.0.9770

DownloadReceivedPurchaseOrderSummary

Downloads the received summary PDF for a purchase order.

Procedure Specific Information

Downloads the received summary PDF for a purchase order. The PurchaseOrderId parameter is required. The file can be saved to a local path via DownloadLocation, written to a stream via FileStream, or returned as base64-encoded data in the FileData output column. The procedure is executed as below:
EXEC DownloadReceivedPurchaseOrderSummary PurchaseOrderId = 'po-123', DownloadLocation = 'C:/temp/received-summary.pdf'

EXEC DownloadReceivedPurchaseOrderSummary PurchaseOrderId = 'po-123'

You can also supply an instance of an output stream in the FileStream parameter.

When neither DownloadLocation nor FileStream is supplied, the downloaded file is returned in the FileData output column as a base64-encoded string.

Input

Name Type Description
PurchaseOrderId String The Id of the purchase order.
DownloadLocation String The local full file path to save the PDF.

Result Set Columns

Name Type Description
FileData String The base64-encoded PDF data. Only populated if DownloadLocation and FileStream are not set.
Status String The status of the operation.

Copyright (c) 2026 CData Software, Inc. - All rights reserved.
Build 26.0.9770