CData Excel Add-In for USPS 2019J - Online Help

GenerateLabels

CData Excel Add-In for USPS 2019J - Build 19.0.7354

Generates a shipping label for the first package in a given shipment. This table will, at a minimum, take pertinent input information from the Shipments, Senders, Recipients, and Packages tables. Depending on the ShipmentId provided, the Payors, CommercialInvoices, and Commodities tables may be examined as well. The output will be a result set of pertinent label information across multiple records. Each record will be automatically inserted into the LabelHistory table.

Procedure Specific Information

The stored procedure will examine the following tables for input:

  • Shipments
  • Senders
  • Recipients
  • Packages
  • Commodities (Intl only)

The stored procedure will add its output as records to the following table:

  • LabelHistory

Execute

In order to execute this procedure, one must specify ServiceType, and ShipmentId. See the example below:

EXECUTE GenerateLabels ServiceType = 'Ground', ShipmentId = '3'

Input

Name Type Description
ShipmentId Integer Identifier for the shipment details to generate the label for.
ServiceType String Type of service for which the rate is applied as enumerated.

使用できる値は次のとおりです。Unspecified, Express, First_Class, Priority, Parcel_Post, Media, Library, Parcel_Select, Critical_Mail, Standard_Mail

LabelImageType String File format of of the generated label as enumerated.

使用できる値は次のとおりです。GIF, EPL, SPL, ZPL, STAR

MailingLocation String Postal Office Zip Code where the item will be mailed (if different from ZipCode).
ShipDate Datetime The date the user requests USPS to pickup the package from the origin, up to 7 days from the future. Required for Stamps if ShipDate is not defined in the specified Shipment.
CustomerId String User-assigned number for internal use. For Endicia requests, this is a unique Id for the partner's end-user that is printing the label.
EndiciaTransactionId String A unique Id for the partner's end-user's transaction. This must be provided when using Endicia.

Result Set Columns

Name Type Description
LabelId Integer Identifier for generated label.
ShipmentId Integer Identifier for applicable shipment.
PackageId Integer Identifier for the specific package for this label.
SenderId Integer Identifier for the shipment's sender.
RecipientId Integer Identifier for the shipment's recipient.
LabelDate Datetime Date the label was generated.
ShipDate String Date the package will be mailed.
NetCharge Decimal Net charge of the entire shipment.
TrackingNumber String Tracking Number for this package.
ShippingLabelFile String File location for the generated label for this package.
IsReturnShipment Boolean Whether or not this label was for a return shipment.
Restrictions String Restrictions on items being shipped based on country of destination.
Regulations String Additional regulations for shipping to the destination country.
Prohibitions String List of items prohibited from mailing to the destination country.
Observations String Additional mailing information based on country of destination.
Notes String Additional information returned by the Server.
IndemnityCoverage Decimal Indicates the indemnity coverage for the package.
TotalValue Decimal Total value of all items being shipped.
SDRValue Decimal Special Drawing Right calculated on TotalValue.

 
 
Copyright (c) 2020 CData Software, Inc. - All rights reserved.
Build 19.0.7354.0