FireDAC Components for UPS

Build 20.0.7587

Shipments

Linked entity associations for a shipment. Every shipment will at least need a Sender, Recipient, and at least one Package. It will be from a specified ShipmentId that certain stored procedures (like GenerateLabels) will fetch needed input information from the other related tables, such as Senders, Recipients, and Packages.

Table Specific Information

The following stored procedures will rely on input from this table:

  • CalculateRates
  • GenerateLabels
  • GenerateReturnLabels

Insert

In order to add a Shipment, one must specify SenderId, RecipientId, and PackageId. See the example below:

INSERT INTO Shipments (SenderId, RecipientId, PackageId) VALUES (3, 7, '9,13,17')
One may specify a ShipmentId on creation. However, if one is not provided, then a ShipmentId be auto-generated.

Columns

Name Type ReadOnly References Description
ShipmentId [KEY] Integer False

Identifier of the shipment preset (required, one will be generated if unspecified).

ShipDate Date False

Date when package will be shipped. This value should be in the format (yyyy-MM-dd).

ShipTime Time False

Time when package will be shipped. This value should be in the format (hh:mm:ss).

PackageId String False

Comma-separated list of packages in shipment. The specified packages must all use the same SizeUnit and WeightUnit. Otherwise, an error may be encountered during the execution of a stored procedure.

SenderId Integer False

The shipment's sender.

RecipientId Integer False

The shipment's recipient.

AccountId Integer False

The shipment's account number holder. This is only to be specified if this person is separate from the sender. If specified, the Senders table will be searched for relevant information. A value of '0' indicates no relation.

PayorId Integer False

The shipment's payor. This is needed if PayorType is set to Recipient or Collect. A value of '0' indicates no relation.

PayorType String False

Type of payor as enumerated.

The allowed values are Sender, Recipient, ThirdParty, Cosignee.

SoldToId Integer False

The party who imports and pays duties on the shipment. This is only to be specified if this person is separate from the recipient. If specified, the Recipients table will be searched for relevant information. A value of '0' indicates no relation. Specific to international shipments.

ShipmentDescription String False

A textual description of goods for the whole shipment. Specific to international shipments.

ShipmentReference String False

Customer-defined number used to identify the whole shipment. Specific to international shipments.

CommercialInvoiceId Integer False

The shipment's commercial invoice. Specific to international shipments. A value of '0' indicates no relation.

CommodityId String False

Comma-separated list of commodities in the shipment. Specific to international shipments.

IsInternational Boolean False

Whether a shipment is international rather than a standard shipment. Applicable to GenerateLabels and GenerateReturnlabels only, and only if the other intl specific columns are specified.

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